home *** CD-ROM | disk | FTP | other *** search
/ Shareware Grab Bag / Shareware Grab Bag.iso / 011 / tickle14.arc / TICKLE.DOC < prev   
Encoding:
Text File  |  1987-08-29  |  21.2 KB  |  560 lines

  1.                                     TICKLE
  2.  
  3.              ------------------------------------------------------
  4.              Comprehensive Command Line Reminder Program for the PC
  5.              ------------------------------------------------------
  6.  
  7.        ***************************************************************
  8.        *PLEASE UPLOAD TO YOUR LOCAL COMPUTER BULLETIN BOARD SYSTEMS! *
  9.        ***************************************************************
  10.  
  11. I.    General
  12.  
  13.       A.  Date
  14.  
  15.           This documentaion was prepared on 08-26-87.
  16.  
  17.       B.  Version
  18.  
  19.           This documentation is updated to version 1.4 of the program.
  20.  
  21.       C.  Purpose
  22.  
  23.           In my profession as a patent attorney and manager for a large
  24. corporation, it is my duty to meet deadlines, to remember a large number of
  25. date sensitive tasks to be done, and to follow up on matters periodically
  26. with my employees and clients.  TICKLE was written to assist me in this
  27. effort.  I hope it will be useful to you also.
  28.  
  29.       D.  The Author
  30.  
  31.           The author is a registered patent attorney working with Rockwell
  32. International Corporation in Cedar Rapids, IA (the old Collins Radio Company).
  33. He can be contacted on Compuserve (ID No.: 71016,1355), or GEnie (Address:
  34. L.MURRAH), or by mail at the following address:
  35.  
  36.                    10 Cottage Grove Woods, S.E.
  37.                    Cedar Rapids, IA 52403
  38.  
  39. The home telephone number is (319) 365-6530.  Please feel free to call about
  40. TICKLE during weekend and early evening hours.
  41.  
  42.       E.  The Software
  43.  
  44.           The development of TICKLE began in June, 1987.  New versions will be
  45. released as features are added and corrections are made to previously released
  46. versions.
  47.  
  48.           TICKLE is written in Turbo Pascal.
  49.  
  50.       F.  Latest Version
  51.  
  52.           The latest version of TICKLE can usually be found on GEnie.  The
  53. latest version can also be obtained by sending a FORMATTED diskette and a
  54. STAMPED, SELF-ADDRESSED diskette mailer to the author at the above address.
  55. The request should be sent with sufficient postage that no postage is due
  56. upon arrival.
  57.  
  58.       G.  Conventions
  59.  
  60.           When example command lines are shown, the sequence "<CR>" means to
  61. press RETURN or ENTER.
  62.  
  63. II.   Equipment and Program Configuration
  64.  
  65.       A.  Setup
  66.  
  67.           TICKLE can be run on the IBM-PC and compatibles having 192K of memory
  68. and one floppy disk drive.  A hard disk is not required, although you will find
  69. that a hard disk will enhance operation of this and any other program.
  70.  
  71.       Your CONFIG.SYS file should authorize at least 20 files.  This can be
  72. done with the following statement:
  73.  
  74.                                   FILES = 20
  75.  
  76.       CONFIG.SYS may be edited using a word processor or program editor.
  77.  
  78.       B.  The System Clock
  79.  
  80.           TICKLE depends upon the system calendar being set correctly.  If you
  81. have a real time clock, you will have a program which automatically sets the
  82. clock and which is usually run in the AUTOEXEC.BAT file.  If not, you will
  83. need to set the date and time with the DATE and TIME DOS commands.
  84.  
  85. III.  Your Right to Use TICKLE
  86.  
  87.       A.  License
  88.  
  89.       As you may have noticed I have retained the copyright in TICKLE,
  90. primarily in order to control its orderly development.  However, I have granted
  91. the right to anyone to use the program for for private use without further
  92. permission from me.  That is, you can copy it, use it, and share it so long as
  93. you do not charge any money for it.
  94.  
  95.       B.  Contributions
  96.  
  97.       Several users have asked me whether I require payment of a "shareware"
  98. fee in order to use the program.  The answer is "No"; but if you would like
  99. to support TICKLE with a small contribution (say $5), we certainly would not
  100. refuse your generosity.  It would certainly help in continuing to improve
  101. the program.
  102.  
  103. IV.  Using TICKLE
  104.  
  105.      A.  Installation
  106.  
  107.          The purpose of installation is to define the drive and subdirectory
  108. in which TICKLE and its associated data files are located.  The TICKLE data
  109. files TICKLE.DTA and TICKLOG.DTA are created the first time TICKLE is run.  If
  110. installation is not performed, it is assumed that the data files are to be
  111. located on the current drive and in the current subdirectory, which may or may
  112. not be the same drive and subdirectory as TICKLE.COM.  In that case it will not
  113. be possible to use TICKLE from all subdirectories.
  114.  
  115.           "Normal" installation assumes that you have a single hard disk
  116. from which you normally boot your computer.  In that case it is suggested that
  117. TICKLE.COM and the TICKLE data files be placed in a subdirectory named
  118. "\TICKLE".  You can either use the following DOS command:
  119.  
  120.                         MD \TICKLE
  121.  
  122. to create the directory and then use the COPY command to copy TICKLE.COM to
  123. that directory, or you can run the TICKINST.BAT program which will do the same
  124. thing for you automatically.
  125.  
  126.           In order that DOS can find TICKLE.COM from any subdirectory, you
  127. should create a file using a word processor or editor named AUTOTEXEC.BAT, if
  128. you have not already done so for other reasons.  The AUTOEXEC.BAT file should
  129. contain the following line:
  130.  
  131.                         PATH = \TICKLE
  132.  
  133. If you already have a path defined in the AUTOEXEC.BAT file, then add \TICKLE
  134. as in the following example:
  135.  
  136.                      PATH = \path1;\path2;\TICKLE
  137.  
  138.           In order that TICKLE.COM will know where to place the data files,
  139. you should include the following line in your AUTOEXEC.BAT file:
  140.  
  141.                      SET TKLSPEC=C:\TICKLE\
  142.  
  143. If you wish to place the data files on another drive or directory, TKLSPEC can
  144. be defined accordingly.
  145.  
  146.            If you are using a floppy disk, you may wish to forget using a
  147. subdirectory.  In that case simply copy TICKLE.COM to the disk in the boot
  148. drive.  You will not need to define the path or use the SET command.  You can
  149. use a subdirectory on a floppy disk, however, and the installation is identical
  150. to normal installation for a hard disk.  If you use a floppy disk, you must
  151. the diskette containing TICKLE in the default drive when you wish to access
  152. TICKLE.
  153.  
  154.      B. General
  155.  
  156.          1. Conventions
  157.  
  158.             When a response from the user is called for, the default response,
  159. i.e., the response which is automatically entered if RETURN is pressed, is
  160. indicated.  To select the default all you have to do is press return.
  161.  
  162.          2. Limits
  163.  
  164.             TICKLE will accept up to 500 notes.  The number of notes used and
  165. the total number authorized (i.e., 500) are indicated at the right of the
  166. header when notes are listed.
  167.  
  168.      C. Use
  169.  
  170.         1.  Batch File Use
  171.  
  172.             One of the most convenient ways to use TICKLE is in the
  173. AUTOEXEC.BAT file which is run each time the the computer is turned on.  Place
  174. it last in the batch file so that you are forced to look at the TICKLE notes
  175. each time you use the computer.  Select the time period (and thus the command)
  176. that is most convenient for you.
  177.  
  178.             An example AUTOEXEC.BAT file, which can be created with a word
  179. processor (ASCII output mode only!) or a text editor is as follows:
  180.  
  181.                         DATE
  182.                         TIME
  183.                         TICKLE W
  184.  
  185.          2.  A Suggested Program of Use
  186.  
  187.              Each morning I run the "O" option to dispose of matters not
  188. cleared from the preceding day's list.  These matters are either deleted,
  189. rescheduled, or filed.  After this is done, I use the "P" option to print a
  190. list for the current day (which also includes important events for the next
  191. 45 days).  I then use this list as my checklist for my day's work.  If new
  192. items are added which need to be done today I write them on the printed list.
  193. I can either enter these items into the TICKLE note data base at the end of the
  194. next day or at the beginning of the next day.
  195.  
  196.      D. Command Line Modes
  197.  
  198.         TICKLE has three command line modes as follows:
  199.  
  200.         1. No Argument Mode
  201.  
  202.            If command line is entered with only the program name, i.e.,
  203.  
  204.                         TICKLE <CR>
  205.  
  206. the main title screen will be displayed along with a list of commands.
  207.  
  208.         2. Entry Mode
  209.  
  210.            Notes may be entered into the TICKLE note file by using the
  211. following command line entry:
  212.  
  213.                         TICKLE MM-DD-YY Text of note <CR>
  214.  
  215. where "MM" is the month, "DD" is the day, and "YY" is the year of the note.
  216. Months, days, and years may be entered as one or two digits each, and the wild
  217. card character "?" may be used in place of any date.  For example, if you wish
  218. for a date to be redisplayed every year without deletion and re-entry, you can
  219. enter a command line such as the following:
  220.  
  221.                         TICKLE 01-01-?? New Year's Day
  222.  
  223. If you wish monthly redisplay, you can enter a command line such as the
  224. following:
  225.  
  226.                         TICKLE ??-01-87 Pay electric bill
  227.  
  228. The text of the note following the date can be up to 80 characters in length.
  229.  
  230. Any date may be made a critical date by inserting a "!" in the text of the
  231. note.  This will ensure that a critical note will be displayed up to 45 days
  232. in advance regardless of the display horizon chosen.  The critical date
  233. feature is useful for planning ahead to accomplish a time consuming task
  234. before the critical date. These dates can also be separately displayed using
  235. the TICKLE ! command.
  236.  
  237. Likewise, any date can be designated as an appointment by inserting the
  238. character "@" in the note.  These notes can be separately displayed with the
  239. TICKLE @ command.
  240.  
  241.         3. Command Mode
  242.  
  243.            In addition to the entry of notes, you can ask TICKLE to perform
  244. several function on the stored file by using the following command line:
  245.  
  246.                         TICKLE % <CR>
  247.  
  248. where "%" is a one letter command as discussed below.
  249.  
  250.      E.  Dates
  251.  
  252.          1.  Valid Range
  253.  
  254.              All date comparisons and calculations in TICKLE assume that dates
  255. are in the range January 1, 1901 and December 31, 1999.  Dates outside this
  256. range will not work!
  257.  
  258.          2.  Date Format and Content
  259.  
  260.              Dates must be entered in the MM-DD-YY format using two digits for
  261. MM, DD, and YY.  Dates in abbreviated format such as "2-7-87" will also be
  262. accepted. Date content is not checked.  Thus 13-56-87 will be accepted even
  263. though it is not a real date. Either "-" or "/" will be accepted to separate
  264. the month from the day from the year.  Thus, "MM/DD/YY" is also an acceptable
  265. format.
  266.  
  267.              Invalid dates may be used for special purposes.  For example, if
  268. you wish to specify that something is to be done during a month without
  269. specifying a particular date, you can use the day "00", e.g., "07-00-87".  The
  270. same trick could be used for the entire year, e.g., "00-00-88".
  271.  
  272.              If you wish to enter non-date-specific notes, you can use an
  273. invalid date such as "00-00-00".  However, this will make your non-dated
  274. notes appear at the beginning of the file.  To make them appear at the
  275. end, you might use "99-99-99".   The invalid date "50-50-50" may not be
  276. used for this purpose, since it is used for other purposes in TICKLE.
  277.  
  278.          3.  Wildcard Dates
  279.  
  280.              If a wildcard ("?") is used to replace any digit in a date, then
  281. both digits are assumed to be wildcards.  Thus, if you enter 01-01-8?, it will
  282. be interpreted as 01-01-??.  All wildcard dates can be displayed using the
  283. TICKLE # command.
  284.  
  285.          4.  Date Shorthand
  286.  
  287.              When entry of a date is expected, you can enter a one character
  288. shorthand for several common dates as follows:
  289.  
  290.              "=" - Today's date
  291.              "-" - Yesterday's date
  292.              "+" - Tomorrow's date
  293.              "`" - One week from today (character is reverse apostrophe!)
  294.              "~" - One month from today
  295.  
  296.      F.  Examining the Notes File
  297.  
  298.          1.  Display Conventions
  299.  
  300.              When notes and their dates are displayed on the monitor screen,
  301. the notes may be accompanied by several symbols which convey important
  302. information about the note.
  303.  
  304.              A "-" before the date means that the note is overdue, i.e., it
  305. has a date earlier that the current date.
  306.  
  307.              A "*" before the date indicates notes having today's date.
  308.  
  309.              A "#" after the date indicates the the date contains wildcard
  310. characters.
  311.  
  312.              A "!" before the date indicates that the note is a critical one.
  313. A note is made critical by typing a "!" in the body of a note.  The critical
  314. symbol will be printed only for dates beyond the current date.
  315.  
  316.          2.  Looking at All Notes
  317.  
  318.              All the notes in the TICKLE file can be examined by entering the
  319. following command line:
  320.  
  321.                         TICKLE A <CR>
  322.  
  323.          3.  Looking Ahead
  324.  
  325.              You can display notes in the TICKLE file for several selectable
  326. future periods as follows:
  327.  
  328.                         TICKLE T <CR>  -  Today's notes
  329.                         TICKLE D <CR>  -  Through the next day
  330.                         TICKLE W <CR>  -  Through the next week
  331.                         TICKLE M <CR>  -  Through the next month
  332.                         TICKLE Q <CR>  -  Through the next quarter
  333.                         TICKLE Y <CR>  -  Through the next year
  334.  
  335.              Any note which is made critical by the insertion of a "!" in the
  336. body of the note is and which is due within 45 days is displayed when the
  337. "T", "D", and "W" commands are used.  This ensures that you are aware of
  338. critical dates sufficiently far in advance to take appropriate actions.
  339.  
  340.          4.  Checking a Particular Date
  341.  
  342.              If you need to check a particular date as when you are scheduling
  343. an appointment, you can use the following command:
  344.  
  345.                          TICKLE K <CR>
  346.  
  347. Enter the desired day at the prompt, and all notes for four days before and
  348. four days before the selected day will be displayed.  This lets you look at
  349. several possible dates for the contemplated event.  Any note on the selected
  350. day will be preceded with the right carat (">") character.  If a date does not
  351. contain a date, a series of dots (....) or dashes (----) will be displayed to
  352. show that the date is free.  Dots are used for weekdays and dashes for weekend
  353. days so that they may be distingusied at a glance.
  354.  
  355.          5.  Special Displays
  356.  
  357.              a.  Critical Dates
  358.  
  359.                  Only the critical dates (i.e., those which include the
  360. character ("!") with the following command:
  361.  
  362.                          TICKLE ! <CR>
  363.  
  364.               b.  Appointments
  365.  
  366.                   All appointments (i.e., notes which include the character
  367. ("@") may be displayed with the following command:
  368.  
  369.                          TICKLE @ <CR>
  370.  
  371.                c.  Wildcard Dates
  372.  
  373.                    All wildcard dates may be displayed using the following
  374. command:
  375.  
  376.                          TICKLE # <CR>
  377.  
  378.      G.  Manipulating Note Dates
  379.  
  380.          1.  Calculating a Date
  381.  
  382.              If you do not know the date on which to enter a date and instead
  383. know only that it is a certain number of days ahead, you can calculate the date
  384. using the following command:
  385.  
  386.                         TICKLE C <CR>
  387.  
  388. You will be prompted for the start date (the default date is the current
  389. date in your system clock) and a number of days to be added to the start
  390. date.  Currently months and years cannot be added to the start date--only
  391. days.
  392.  
  393.          2.  Revising a Note
  394.  
  395.              A note can be deleted, rescheduled, logged, or edited using the
  396. following command:
  397.  
  398.                         TICKLE R <CR>
  399.  
  400. When this command is invoked, you will be asked to identify the date of the
  401. note to be revised.  When the note is located, you will be asked to select one
  402. of four revise actions and will be prompted for the action selected.
  403.  
  404.               a.  Deleting
  405.  
  406.                   Deleting is accomplished by selecting the delete action.  No
  407. further action is required.
  408.  
  409.               b.  Rescheduling
  410.  
  411.                   To reschedule all you need to do is to enter the new date
  412. (or shorthand) when prompted.
  413.  
  414.                c.  Logging
  415.  
  416.                    Logging is accomplished by selecting the log action.  No
  417. further action is required.
  418.  
  419.               d.  Editing
  420.  
  421.                   Editing is accomplished by entering a combination of letters
  422. in the following form when prompted:
  423.  
  424.                         oldstring;newstring
  425.  
  426. where "oldstring" is a combination of characters containing the incorrect part
  427. of the note being edited, and "newstring" is another combination of characters
  428. which is to be substituted for oldstring.  For example, in the following note:
  429.  
  430.                         Call the home offce
  431.  
  432. can be corrected by entering the following when prompted:
  433.  
  434.                             offce;office
  435.  
  436.      H.  Searching for a Note
  437.  
  438.          If you cannot remember the date of a note but do remember a word (or
  439. a fragment of a word) in the note, you can search for it using the following
  440. command:
  441.  
  442.                         TICKLE S <CR>
  443.  
  444. Enter the "search string" (i.e., word, part of a word, or character
  445. combination) when prompted.  Notes can easily be classified and searched with
  446. this command using a special set of characters, such as initials, as part of
  447. the note.
  448.  
  449.      I.  Overdue Notes
  450.  
  451.          The user can review all overdue notes (that is, notes having a
  452. date earlier than the current system clock date) regardless of date using
  453. the following command:
  454.  
  455.                         TICKLE O <CR>
  456.  
  457. Each overdue note (i.e., notes having dates earlier than the current date)
  458. will be selected and the user will be asked whether to delete, log, or
  459. reschedule the note.
  460.  
  461.      J.  The Log File
  462.  
  463.          Instead of simply erasing a note from the file, you may wish to move
  464. it to another file for later review.  If you do a monthly report, this "log"
  465. file may be a handy reminder of what you did last month.
  466.  
  467.          1.  Logging Notes
  468.  
  469.              When you have finished with a note, you can move it to the log
  470. file with the Revise command as previously discussed.
  471.  
  472.          2.  Viewing the Log
  473.  
  474.              You can view the log by issuing the View command as follows:
  475.  
  476.                         TICKLE L <CR>
  477.  
  478.          3.  Erasing the Log
  479.  
  480.              When you are finished with the log, you can erase it and start
  481. over using the Erase command as follows:
  482.  
  483.                         TICKLE Z <CR>
  484.  
  485.           4.  Printing the Log File
  486.  
  487.               At the end of the month when you do your monthly report, you
  488. print a copy of the log file with the following command:
  489.  
  490.                         TICKLE G <CR>
  491.  
  492.            5.  Filing a Note to the Log File
  493.  
  494.                Sometimes you may wish to simply enter a note in the log file
  495. without having first entered it into the note file.  This would most often
  496. occur when you do a task as soon as it arrives at your office and you want to
  497. remember it for your monthly report.  The following command will accomplish
  498. this:
  499.  
  500.                         TICKLE F <CR>
  501.  
  502.      L.  Printing the Notes File
  503.  
  504.          The notes file for a day, week, month, or year ahead can be printed
  505. in chronological order on a line printer using the following command:
  506.  
  507.                         TICKLE P <CR>
  508.  
  509. The user is asked to select the period to be printed and to prepare the
  510. printer.  A suggested use of the Print command is to make a hardcopy for the
  511. current day at the start of the day and use it as your "to do" list for the
  512. day.
  513.  
  514.      M.  Backing Up Data Files
  515.  
  516.          You can back up the TICKLE.DTA and TICKLOG.DTA files to either drive
  517. A: or B: using the following command:
  518.  
  519.                         TICKLE B <CR>
  520.  
  521. Be sure to have a formatted diskette ready, and enter the desired backup drive
  522. ("A" or "B") when prompted.  The colon (":") is not needed after the backup
  523. drive letter!
  524.  
  525. V.   We Need Your Feedback!
  526.  
  527.      As I continue to improve TICKLE, it is helpful for me to have your
  528. feedback about what you like about TICKLE, what you don't like about it, what
  529. would make it easier to use, any bugs or cosmetic defects you have discovered,
  530. what you would like to see changed or added, etc.  Please take the time to fill
  531. out and mail the form in the file FEEDBACK.FRM to me.  It would be much
  532. appreciated by the author and other users.
  533.  
  534.          If you would like to have the latest version of TICKLE, please send a
  535. FORMATTED diskette and a SELF-ADDRESSED, stamped diskette mailer along with
  536. your feedback form.
  537.  
  538.  
  539.                                     APPENDIX
  540.  
  541.                                  TICKLE Commands
  542.  
  543. A - List all notes in TICKLE file       Q - List TICKLE file for next quarter
  544. B - Backup TICKLE file                  R - Reset date of TICKLE note
  545. C - Calculate TICKLE date               S - Search for TICKLE note
  546. D - List TICKLE notes for tomorrow      T - List TICKLE file for today
  547. E - Erase TICKLE log                    V - View TICKLE log
  548. L - Save note to log file               W - List TICKLE notes for next week
  549. M - List TICKLE notes for next month    X - Delete TICKLE note
  550. O - Remove overdue TICKLE notes         Y - List TICKLE notes for next year
  551. P - Print TICKLE notes file');
  552.  
  553.                                  Shorthand Dates
  554.  
  555. "-"  Yesterday
  556. "="  Today
  557. "+"  Tomorrow
  558. "`"  One Week from Today  (this is the reverse apostrophe!)
  559. "~"  One Month from Today
  560.